home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / pcbfre25.zip / PCBFRE.DOC < prev    next >
Text File  |  1992-05-07  |  42KB  |  1,034 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                          PCBFRE
  16.  
  17.                           PCBoard Dynamic File Ratio Enforcer
  18.  
  19.  
  20.                            A PCBoard Post/Call Ratio Enforcer
  21.                               Post/Download Ratio Enforcer
  22.                                   Files Ratio Enforcer
  23.                                   Bytes Ratio Enforcer
  24.                                      Time/Byte Bank
  25.                                 Bytes Per Message Reward
  26.  
  27.  
  28.                                Version 2.2  (07-May-1992)
  29.  
  30.                                       PCBFRE22.ZIP
  31.  
  32.                           For use with PCBoard Versions 14.5+
  33.  
  34.  
  35.  
  36.                             Copyright 1991, 1992 Geoffrey Sy
  37.                                   ALL RIGHTS RESERVED
  38.  
  39.  
  40.  
  41.                              This program is supported by:
  42.  
  43.  
  44.  
  45.                                       Geoffrey Sy
  46.                                      51 Wyatt Walk
  47.                                 Toronto, Ontario  Canada
  48.                                         M5A 3T3
  49.  
  50.  
  51.                                       Support BBS:
  52.  
  53.                                  The GRAFIX Connection
  54.                                   HST: (416) 287-9002
  55.                                   2400: (416) 286-8734
  56.  
  57.                         Best time to call: 5:30 - 9:00 am E.S.T.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.            ┌────────────────────────────────────────────────────────────────┐
  66.            │                        TABLE OF CONTENTS                       │
  67.            └────────────────────────────────────────────────────────────────┘
  68.  
  69.  
  70.           Introduction .................................................... 3
  71.  
  72.           Installation .................................................... 3
  73.                Edit PCBoard's PWRD ........................................ 3
  74.                Using FRESM ................................................ 3
  75.                Edit PCBFRE's Configuration ................................ 4
  76.                Edit PCBFRE Ratio table .................................... 5
  77.                The Ratio System Examples .................................. 6
  78.                Edit Bank Limits ........................................... 7
  79.                Edit PCBoard's Door Security File .......................... 7
  80.                Edit PCBFRE Door Script file ............................... 8
  81.                PCBFRE Command line options ................................ 8
  82.                Trial Run .................................................. 9
  83.                Edit FRETEXT ............................................... 9
  84.                PCBFRE's Display Files ................................. 4, 10
  85.                PCBFRE Display Files Substitution Variables ............... 10
  86.                PCBFRE banking features ................................... 12
  87.  
  88.           Program Capabilities............................................ 13
  89.                Security/Language specific display files .................. 13
  90.                Non-Standard COM Ports .................................... 13
  91.                Session Logging ........................................... 13
  92.                Multi-Tasking/Node Support ................................ 13
  93.                Network, File Sharing Support ............................. 13
  94.                SysOp Function Keys ....................................... 14
  95.  
  96.           Error Codes ................................................ 14, 15
  97.                Problem Report Procedure .................................. 15
  98.  
  99.           Support/Registrations........................................... 16
  100.  
  101.           Disclaimers/Copyrights/Credits ................................. 17
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.           ─────────────────────────────────────────────────────────────────
  118.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 2
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.            ┌────────────────────────────────────────────────────────────────┐
  127.            │                           INTRODUCTION                         │
  128.            └────────────────────────────────────────────────────────────────┘
  129.  
  130.  
  131.           PCB File Ratio Enforcer was created  to compliment PCBoard's lack of
  132.           ratio enforcement.   PCBFRE is a  door for PCBoard  14.5+ to enforce
  133.           the available  download bytes based  on download/upload,  post/call,
  134.           post/download ratios.   Some enhanced features include bytes  reward
  135.           for message posts and a unique time/byte banking system.
  136.  
  137.  
  138.            ┌────────────────────────────────────────────────────────────────┐
  139.            │                  PROGRAM INSTALLATION/OPERATION                │
  140.            └────────────────────────────────────────────────────────────────┘
  141.  
  142.  
  143.           Step #1:
  144.           =======
  145.  
  146.           Edit PCBoard's PWRD file and set daily download  bytes to 0 for  the
  147.           security levels to  be enforced with PCBFRE.   This step is required
  148.           to stop  PCBoard from  giving the user  any bytes.   When PCBFRE  is
  149.           used, PCBFRE calculates the amount of bytes  the user is allowed  to
  150.           receive based on his ratios.
  151.  
  152.  
  153.           Step #2:
  154.           ========
  155.  
  156.           Edit PCBFRE's configuration file.  The  one included in this archive
  157.           is called  PCBFRE.CNF.   Please use FRESM  to edit this  file.   The
  158.           command line for starting FRESM is:
  159.  
  160.                                FRESM  PCBFRE.CNF  C:\PCB
  161.                                          │        │
  162.                                          │        └┤ PCBoard System directory
  163.                                          │
  164.                                          └─────────┤ Name of CNF file
  165.  
  166.           FRESM  will create  a configuration  file  if  one does  not already
  167.           exist.  The location of your  PCBoard Systems directory is  required
  168.           for FRESM  to obtain the colour  and text  editor configuration from
  169.           PCBSM.CNF and PCBSM.CLR.
  170.  
  171.  
  172.           There are 3 options on the main menu:
  173.  
  174.                              A - Edit Configuration File
  175.                              B - Edit PCBFRE Security Table
  176.                              C - Edit Banking Data File
  177.  
  178.           ─────────────────────────────────────────────────────────────────
  179.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 3
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.           Option A:      Edits PCBFRE's configuration file options.
  188.            
  189.           1.   ║  BBS Name: Simple Solutions Software          
  190.           2.   ║  Registration # 0
  191.                ║                                               
  192.           3.   ║  Use slow BIOS comm driver (Y/N): N           
  193.                ║                                               
  194.           4.   ║  NORMAL display file              : NORMAL    
  195.           5.   ║  FILES/BYTES EXCEEDED display file: FILES     
  196.           6.   ║  MESSAGE EXCEEDED display file    : MSGS      
  197.           7.   ║  RATIO NOT ENFORCED display file  : EXEMPT    
  198.                ║                                               
  199.           8.   ║  FRE Bank Welcome display file    : WELCOME   
  200.           9.   ║  FRE Bank Goodbye display file    : GOODBYE   
  201.           10.  ║  FRE Bank Help display file       : HELP      
  202.           11.  ║  FRE Bank Menu display file       : MENU      
  203.  
  204.                1.   This  is where  you enter  your  BBS  name.   If you  have
  205.                     registered PCBFRE, this must be the  same as the BBS  name
  206.                     entered in PCBoard.
  207.  
  208.                2.   The  registration  code  you  receive  when  you  register
  209.                     PCBFRE.
  210.  
  211.                3.   This  tells PCBFRE  how to  communicate with  your  modem.
  212.                     Older PCs and not 99%+ MS-DOS compatible machines such  as
  213.                     Tandy and alike may  need to set this  to Y.   The setting
  214.                     for the  majority of  PCs is  N.   If one setting  doesn't
  215.                     work on your PC, the other might.
  216.  
  217.                4.   This text file will be displayed  when the user's ratio is
  218.                     within normal limit.
  219.  
  220.                5.   This text file will be displayed  when the user's files or
  221.                     bytes ratio has been exceeded.
  222.  
  223.                6.   This text file will  be displayed when the user's messages
  224.                     ratio has been exceeded.
  225.  
  226.                7.   This  text file  will be displayed when  the user's ratios
  227.                     are not being enforced by PCBFRE.
  228.  
  229.                8.   This  file will  be  displayed when  the  user  enters the
  230.                     bank.
  231.  
  232.                9.   This file will be displayed when the user exits the bank.
  233.  
  234.                10.  This file explains the  commands in the bank.  The '?'  or
  235.                     'H' command will display it.
  236.  
  237.                11.  The list of commands and short explanations for the bank.
  238.  
  239.           ─────────────────────────────────────────────────────────────────
  240.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 4
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.           Option B:
  249.           --------
  250.           This  option edits PCBFRE's  Security levels  table.   This is where
  251.           the ratio options for the security levels are controlled.
  252.  
  253.           1.   ║  Security Level ....... 60
  254.           2.   ║  Bytes Ratio .......... 3.00
  255.           3.   ║  Files Ratio .......... 4.00
  256.           4.   ║  Message Ratio ........ 7.00
  257.           5. 6.║  Maximum Daily Limit .. 204800       Enforce Daily (Y/N)? N
  258.           7.   ║  Base Baud Rate ....... 0
  259.           8. 9.║  Bytes per Message .... 1024         Enforce Daily (Y/N)? N
  260.  
  261.           10.  ║  Bank Daily Time Limit ...... 30
  262.           11.  ║  Bank Maximum Time Bal ...... 60
  263.           12.  ║  Bank Daily Bytes Limit ..... 102400
  264.  
  265.                1.   The security level to be enforced.
  266.  
  267.                2.   The number  of bytes the user  may download  for each byte
  268.                     uploaded.
  269.  
  270.                3.   The  number of file  the user  may download  for each file
  271.                     uploaded.
  272.  
  273.                4.   The  number of calls  or downloads  the user  may make for
  274.                     each message left.
  275.  
  276.                5.   The maximum byte limit the user  may download per session.
  277.                     Set it to 0 if you don't want the user to download.
  278.  
  279.                6.   When  this  is set  to Y,  the maximum  limit (item  5) is
  280.                     only calculated on the first call.
  281.  
  282.                7.   Similar to  PCBoard's base  baud rate  setting. When  set,
  283.                     the maximum  daily limit will be adjusted according to the
  284.                     user's connect baud rate.
  285.  
  286.                8.   The  number of bytes  given to  the user  for each message
  287.                     post.
  288.  
  289.                9.   This setting  decides when  to reward  the message  posts.
  290.                     When  set to Y  PCBFRE will only reward  the user once per
  291.                     day.  When  the N setting is  used, the bytes are rewarded
  292.                     every time PCBFRE detects a new message post.
  293.  
  294.                10.  The number of minutes the user may withdraw per day.
  295.  
  296.                11.  Then maximum number of minutes allowed in the account.
  297.  
  298.                12.  The number of bytes the user may withdraw per day.
  299.  
  300.           ─────────────────────────────────────────────────────────────────
  301.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 5
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.            ┌────────────────────────────────────────────────────────────────┐
  310.            │                         THE RATIO SYSTEM                       │
  311.            └────────────────────────────────────────────────────────────────┘
  312.  
  313.  
  314.           The illustration on the previous page translates to the following:
  315.  
  316.                     Bytes ratio:        3:1       Files ratio:        4:1
  317.                     Messages ratio:     7:1
  318.                     Session limit:      200K
  319.                     BPM reward:         1K
  320.  
  321.                     Bank balance limit:      60 minutes
  322.                     Bank daily limit:        30 minutes
  323.                     Bytes withdrawal limit:  100K
  324.  
  325.                Users with  security level  60 may  download 3  bytes for  each
  326.                byte they upload  up to a  maximum of  200K per  session.   For
  327.                every  4 files they  download they  must upload  one file. They
  328.                must post  1 message every 7  calls and are  given 1K for  each
  329.                message they  post.   All ratios and  rewards are  recalculated
  330.                each  time PCBFRE  is executed.   Baud  rate is not  taken into
  331.                account.
  332.  
  333.  
  334.           Let's take a look at  another example.  This one is for those SysOps
  335.           who value message participation than files:
  336.  
  337.                     Bytes ratio:        1:1       Files ratio:        0:0
  338.                     Messages ratio:     1:1
  339.                     Session limit:      200K
  340.                     BPM reward:         5K
  341.  
  342.                Users  are  required  to  upload  1  byte  for  each  byte they
  343.                download up to a  maximum of 200K per session.  They must  post
  344.                a message each call and are given 5K for each message post.
  345.  
  346.                If the  1:1 post/call ratio  system cause the phone  line to be
  347.                free all  the time, the post/download  ratio system  may be the
  348.                answer.  Use the command line switch /POSTDL to enable this.
  349.  
  350.  
  351.           For BBSes where bytes don't count  much, such as systems specialized
  352.           in game cheats, un-protects, docs:
  353.  
  354.                     Bytes ratio:        0:0       Files ratio:        1:1
  355.                     Messages ratio:     0:0
  356.                     Session limit:      100K
  357.  
  358.                Users are required to upload one  file for each one downloaded.
  359.                After every 100K downloads, they must recalculate their ratio.
  360.  
  361.           ─────────────────────────────────────────────────────────────────
  362.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 6
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.           Option C:
  371.           --------
  372.           This option edits PCBFRE's banking data file.  Use  this function to
  373.           modify information in the banking data file.
  374.  
  375.           1.   ║  Name ................. GEOFFREY SY
  376.           2.   ║  Account balance ...... 200
  377.           3.   ║  Date withdraw time ... 03-09-92                       
  378.           4.   ║    Amount withdrew .... 10
  379.                ║                                                        
  380.           5.   ║  Date withdraw bytes .. 03-09-92                       
  381.           6.   ║    Bytes withdrew ..... 0
  382.                ║                                                        
  383.           7.   ║  Date of BPM reward ... 03-09-92                       
  384.           8.   ║  BPM message pointer .. 4
  385.  
  386.                1.   The account holder's name
  387.  
  388.                2.   The current time balance
  389.  
  390.                3.   Date when time was withdrawn
  391.  
  392.                4.   Amount withdrew on that date (item 3)
  393.  
  394.                5.   Date when bytes were withdrawn
  395.  
  396.                6.   Number of bytes withdrawn on that date (item 5)
  397.  
  398.                6.   Date when Bytes/Message reward was given
  399.  
  400.                8.   Number of messages the user posted at that point in time.
  401.  
  402.  
  403.           Step #3:
  404.           =======
  405.  
  406.           Setup PCBFRE as a PCBoard Door.  Load  up PCBSetup, go to edit  door
  407.           security file and add the following line:
  408.  
  409.  
  410.                                        USER DOOR
  411.           Filename Password  Sec Login SYS  SYS  Shell Path to DOOR files
  412.           ════════ ════════  ═══ ═════ ════ ════ ═════ ══════════════════
  413.           PCBFRE              0   Y    Y    N     Y
  414.  
  415.  
  416.           The Autologin and Shell options are optional.  If you run more  than
  417.           one autologin program, you may want to combine  all of them into one
  418.           script file.  PCBFRE requires about 128K  to operate.  Make sure you
  419.           have enough  memory if  you want PCBoard  to shell to  PCBFRE.   The
  420.           USERS.SYS option must be set to Y or PCBFRE won't work! 
  421.  
  422.           ─────────────────────────────────────────────────────────────────
  423.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 7
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.           The following  is your typical  PCBoard door  script file.   The one
  432.           included in this package is named "PCBFRE".
  433.  
  434.                REM Door script for PCBFRE - PCBoard File Ratio Enforcer.
  435.                %PCBDRIVE%
  436.                CD \PCB\FRE
  437.                PCBFRE PCBFRE.CNF %PCBDRIVE%%PCBDIR%  /POSTDL /NEW:204800:1:1
  438.                CD %PCBDIR%
  439.                IF (%INPCB%)==(Y) EXIT
  440.                BOARD
  441.  
  442.           Here's the explanation of PCBFRE's command line:
  443.                                            
  444.               PCBFRE PCBFRE.CNF C:\PCB  /POSTDL /NEW:204800:1:1
  445.                          │         │    │       │
  446.                          │         │    │       └─┤ Award new user with
  447.                          │         │    │         │ starting bytes, files,
  448.                          │         │    │         │ and messages
  449.                          │         │    │
  450.                          │         │    └─────────┤ Enforce post/download
  451.                          │         │              │ instead of post/call
  452.                          │         │
  453.                          │         └──────────────┤ Location of your PCBoard
  454.                          │                        │ Node directory
  455.                          │
  456.                          └────────────────────────┤ Pathname of PCBFRE's
  457.                                                   │ configuration file
  458.  
  459.           The first  two (2) options on the  command are a  must, the rest are
  460.           optional.
  461.  
  462.  
  463.           Available command line options:
  464.  
  465.             /STRICT -    This option  tells PCBFRE  to enforce strict  ratios.
  466.                          Normally  a  user  does  not  consider  exceeded  his
  467.                          post/calls  ratios  unless  he  downloads.  With  the
  468.                          strict rule  in effect, downloads  are not used  when
  469.                          determining post/calls ratio. This  will mean if  the
  470.                          user  uploaded nothing and/or  posted no messages, he
  471.                          is  considered  exceeding his  post/calls  and  files
  472.                          ratios.
  473.  
  474.             /POSTDL -    This  tells PCBFRE  to enforce  "Messages  Post/Files
  475.                          Download"  Ratio   instead  of  the  normal  Messages
  476.                          Post/Calls Ratio.
  477.  
  478.             /$$LOGOFF -  This tells  PCBFRE  to  run  your  $$LOGOFF.BAT  file
  479.                          before clearing out the PCBOARD.SYS when a user  logs
  480.                          off inside the bank.  
  481.  
  482.  
  483.           ─────────────────────────────────────────────────────────────────
  484.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 8
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.             /NEW:204800:1:1 - This tells PCBFRE to give new users some
  493.                     │   │ │   upload credits.
  494.                     │   │ │
  495.                     │   │ └──────────────────┤ The number of message
  496.                     │   │                    │ posts to give new users
  497.                     │   │
  498.                     │   └────────────────────┤ The number of uploaded
  499.                     │                        │ files to give new users
  500.                     │
  501.                     └────────────────────────┤ The number of uploaded
  502.                                              │ bytes to give new users
  503.  
  504.                New users affected by the /NEW option must meet the following
  505.                criteria:
  506.  
  507.                      Files Uploaded and Downloaded = 0
  508.                      Bytes Uploaded and Downloaded = 0
  509.                      User's security level must exist in PCBFRE's ratio table
  510.  
  511.           That's all  that's needed.   The  line "IF  (%INPCB%)==(Y) EXIT"  is
  512.           used to  exit from  shelled doors.   If  you don't  run PCBFRE  as a
  513.           shelled door then you may remove it.
  514.  
  515.  
  516.           Step #4:
  517.           ========
  518.  
  519.           TRIAL  RUN.  If  you have  a runtime error please  check the runtime
  520.           error codes in this document.
  521.  
  522.  
  523.           Step #5:
  524.           ========
  525.  
  526.           FRETEXT contains 2 lines of text.  The first line is displayed  when
  527.           a  new user is awarded  "Start-Up" bytes/files.  The  second line is
  528.           displayed when a user receives "Bytes Per Message" reward.  You  may
  529.           use the  macro %\FILE to display external text files. In addition to
  530.           the macros listed on  the next page,  the following macros are  also
  531.           available:
  532.  
  533.               Available when "Bytes Per Message" are awarded:
  534.  
  535.                @BPMREWARD@         Bytes rewarded for new messages posted
  536.                @BPMPOSTS@          Messages posted qualified for BPM reward
  537.  
  538.               Available when new user "Start-Up" bytes are awarded:
  539.  
  540.                @NEWBYTES@          New users bytes awarded
  541.                @NEWFILES@          New users files awarded
  542.                @NEWMSGS@           New users messages awarded
  543.  
  544.           ─────────────────────────────────────────────────────────────────
  545.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 9
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.           All external display files  may be edited to your own taste to match
  554.           the theme of your BBS. See below  (PROGRAM CAPABILITIES) if you want
  555.           to  create  language-specific or  security-level-specific  displays.
  556.           From FRESM, press F2  to edit the non-colored version and F3 to edit
  557.           the ANSI  version.  All ASCII,  ANSI and IBM graphics characters are
  558.           supported in  the display  files.   You can  use all PCBoard's  @X##
  559.           colour codes as well as the following variables:
  560.  
  561.                @MSGRATIO@     SysOp set # of calls allowed per post
  562.                @FILERATIO@    SysOp set # of files download per upload
  563.                @BYTERATIO@    SysOp set # of bytes download per upload
  564.                @ADJBYTES@     Adjusted download bytes available
  565.                @MSGLEFT@      Messages user has left/uploaded to PCBoard
  566.                @MSGREAD@      Message user has read/downloaded from PCBoard
  567.                @BPMBYTES@     Bytes per message in the ratio table
  568.                @EARNEDBYTES@  The maximum bytes the user has earned
  569.                @EARNEDFILES@  Tiles earned - the number of files the user  may
  570.                               download before exceeding Files UL/DL ratio
  571.                @EARNEDMSGS@   Messages earned - the number of  downloads or   
  572.                               calls the user may make before  exceeding the   
  573.                               Post/Call or Post/Download ratios
  574.                @TIMEBAL@      Bank time balance
  575.                @MAXTBAL@      Bank maximum balance allowed by SysOp
  576.                @TIMEAVAIL@    Bank time available for withdrawal
  577.                @MAXTAVAIL@    Bank maximum daily limit allowed by SysOp
  578.                @BYTESAVAIL@   Bank bytes available for withdrawal
  579.                @MAXBAVAIL@    Bank maximum daily limit allowed by SysOp
  580.  
  581.                $B$            modem open baud rate
  582.                $C$            connect bps same as @BPS@
  583.                $CLREOL$       clear to end of line
  584.                $DEFAULT$      the default color
  585.                $N$            port number 0=local, 1..4
  586.                $NODE$         current node number
  587.                $NONSTOP$      display the rest of the file non-stop
  588.                $SYSOP$        sysop name
  589.                $TIME$         daily time limit in minutes
  590.                @BEEP@         beep speaker, control-g
  591.                @BOARDNAME@    the name of your BBS
  592.                @BPS@          estimated connect bps
  593.                @CITY@         city and state of caller (all caps)
  594.                @CLS@          clear screen
  595.                @DATAPHONE@    caller's business/data phone number
  596.                @DLBYTES@      total bytes downloaded - all calls
  597.                @DLFILES@      total files downloaded - all calls
  598.                @EVENT@        time of next scheduled event
  599.                @EXPDATE@      subscription expiration date
  600.                @FIRST@        first name of the user 
  601.                @HOMEPHONE@    caller voice phone number
  602.                @LASTDATEON@   last date on (mm-dd-yy format)
  603.                @LASTTIMEON@   last time on (hh:mm format)
  604.  
  605.           ─────────────────────────────────────────────────────────────────
  606.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 10
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.                @NUMTIMESON@   number of times on system
  615.                @SECURITY@     users current security level incl. conf. add.
  616.                @SYSDATE@      host date in (mm-dd-yy format)
  617.                @SYSTIME@      host system in (hh:mm format)
  618.                @TIMELEFT@     time remaining that call incl. all credits
  619.                @TIMELIMIT@    time allowed from PWRD file
  620.                @TIMEUSED@     minutes used since logon
  621.                @UPBYTES@      total bytes uploaded - all calls
  622.                @UPFILES@      total files uploaded - all calls
  623.                @USER@         complete name of the caller
  624.                @WAIT@         force a "press enter to continue" prompt
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.           ─────────────────────────────────────────────────────────────────
  667.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 11
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.            ┌────────────────────────────────────────────────────────────────┐
  676.            │                         BANKING FEATURE                        │
  677.            └────────────────────────────────────────────────────────────────┘
  678.  
  679.           If you  want to activate the banking feature, just create a separate
  680.           door script  and use  the /BANK  switch on  the command  line.   The
  681.           sample door script for  the bank is included in the archive as BANK.
  682.           The content of the script follows:
  683.  
  684.                @ECHO OFF
  685.                rem PCBFRE - PCBoard File Ratio Enforcer - BANKING FUNCTIONS
  686.                %PCBDRIVE%
  687.                CD \DOORS\PCBFRE
  688.                PCBFRE PCBFRE.CNF %PCBDIR% /BANK
  689.                CD %PCBDIR%
  690.                IF (%INPCB%)==(Y) EXIT
  691.                BOARD
  692.  
  693.           The  time bank feature  in PCBFRE  is just  your ordinary  time bank
  694.           system, it allows deposits and withdraws.
  695.  
  696.           The bytes bank  is unique.   It was  designed to encourage  uploads,
  697.           instead of allowing  users to  stockpile their bytes left-over  from
  698.           their daily limits.   With this banking  system, the more  the users
  699.           upload the more bytes they'll have to withdraw.
  700.  
  701.           For users with bytes ratios not  enforced, when bytes are withdrawn,
  702.           the amount equal to  the user's ratio is taken from the user's total
  703.           upload to  increase the user's bytes  available for the  day.  These
  704.           users'  bank ratio is  determined by  the last  security level read.
  705.           The security  levels are  sorted in  descending order,  so the  last
  706.           level  read  would be  the  lowest  level.  Since  the lowest  level
  707.           allowed is  0, you may  use that to  determine the  bank bytes ratio
  708.           for those users.
  709.  
  710.           For example: A user  with a 4:1 bank  ratio withdraws 100K  from the
  711.           bank.  This is how the 100K would be calculated:
  712.  
  713.                Each upload  byte is worth 4  download bytes,  so 100K download
  714.                bytes would require 25K upload bytes.
  715.  
  716.                                    100K / 4 = 25K
  717.  
  718.                25K is  then  subtracted from  the  total  upload and  100K  is
  719.                added to the bytes available.
  720.  
  721.           For users  with bytes ratios enforced,  the bank  will calculate the
  722.           proper amount they may withdraw without exceeding their ratios.
  723.  
  724.  
  725.  
  726.  
  727.           ─────────────────────────────────────────────────────────────────
  728.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 12
  729.  
  730.  
  731.  
  732.  
  733.  
  734.  
  735.  
  736.            ┌────────────────────────────────────────────────────────────────┐
  737.            │                       PROGRAM CAPABILITIES                     │
  738.            └────────────────────────────────────────────────────────────────┘
  739.  
  740.  
  741.           PCBFRE is a standard ProKit door.  Some of its features include:
  742.  
  743.                +    Security-level / Language specific display files:
  744.  
  745.                     To activate this feature,  replace the first  3 letters of
  746.                     the menu name with the security level.
  747.  
  748.                               For level 60,  NORMAL becomes 060MAL
  749.  
  750.                     For language  specific menu, let  say French  just add the
  751.                     extension as specified in PCBoard.
  752.  
  753.                           For French (.FRE), NORMAL becomes NORMAL.FRE
  754.                           Add level specific and it becomes  060MAL.FRE
  755.  
  756.                +    Support for  non-standard COM ports COM3  - COM8.   If the
  757.                     door  doesn't work  with your  COM  port  you may  set the
  758.                     following environment variables:
  759.                                SET COMBASE=nnnn
  760.                     Sets the  base I/O address  (in DECIMAL) for  non-standard
  761.                     COM ports.
  762.                                SET COMIRQ=n
  763.                     Sets the IRQ level for non-standard COM ports.
  764.  
  765.                +    Full Multi-Node support.
  766.  
  767.                +    Support for Baud Rates up to 115200 bps.
  768.  
  769.                +    Complete session logging. Everything the user sees can  be
  770.                     captured in a session log.  This is enabled by adding
  771.                                SET PRODEBUG=ON
  772.                     to the door script;  output will be logged to DEBUG.OUT.
  773.  
  774.                +    Operation under DoubleDOS, TaskView  or DesqView is  fully
  775.                     supported. The  door will give up  idle time  to speed the
  776.                     other  partition.  If screen  bleedthrough  or  background
  777.                     lockups  occur,  you  may  need  to  add  the  environment
  778.                     statement
  779.                                SET OVCRT=ON
  780.                     before executing  the door.   This disables direct  screen
  781.                     write.
  782.  
  783.                +    Automatic network  file  sharing  is  implemented  on  all
  784.                     system files.  The door has  been tested under  LanTastic,
  785.                     Novell, NTNX and other true networks.
  786.  
  787.  
  788.           ─────────────────────────────────────────────────────────────────
  789.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 13
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.  
  797.                +    Sysop function keys supported are:
  798.                       F2  .... Lockout current user
  799.                       F3  .... Toggle printer logging
  800.                       F4  .... Toggle operator page bell
  801.                       F5  .... Shell to DOS while caller is online
  802.                       F7  .... Toggle alarm beeps
  803.                       F8  .... Force immediate logoff and hangup
  804.                       F9  .... Toggle local display
  805.                       F10 . .. Chat with user
  806.                       ALT-B .. Debug/display memory and overlay information
  807.                       ALT-I .. File input during message entry and CHAT
  808.                       ALT-F .. File capture of all displays
  809.                       ALT-M .. Node status display
  810.                       ALT-N .. Sysop on-next
  811.                       ALT-P .. Print complete session
  812.                       ALT-X .. Sysop dos-exit next
  813.                       UP   ...   Increase online time
  814.                       DOWN ... Decrease online time
  815.                       PgUp ... Display comments from user file
  816.                       PgDn ... Display phone numbers, password
  817.                       HOME ... Listing available functions
  818.                       SHIFT .. F1..F10 . Sysop macro keys defined in PCBSETUP
  819.  
  820.  
  821.            ┌────────────────────────────────────────────────────────────────┐
  822.            │                           ERROR CODES                          │
  823.            └────────────────────────────────────────────────────────────────┘
  824.  
  825.  
  826.                Error    Class     Description
  827.  
  828.                   2     DOS:       File not found  (Check command line)
  829.                   3     DOS:       Path not found
  830.                   4     DOS:       Too many open files (Check CONFIG.SYS)
  831.                   5     DOS:       File access denied
  832.                   6     DOS:       Bad file handle
  833.                  12     DOS:       Bad file access code
  834.                  16     DOS:       Can't remove current dir
  835.                  15     DOS:       Bad drive number
  836.                 100     I/O:       Disk read error
  837.                 101     I/O:       Disk write error
  838.                 102     I/O:       File not assigned
  839.                 103     I/O:       File not open
  840.                 104     I/O:       File not open for input
  841.                 105     I/O:       File not open for output
  842.                 106     I/O:       Bad numeric format (Check numbers in .CNF)
  843.                 150     CRITICAL:  Disk is write-protected
  844.                 151     CRITICAL:  Unknown unit
  845.                 152     CRITICAL:  Drive not ready
  846.                 153     CRITICAL:  Unknown command
  847.                 154     CRITICAL:  CRC error in data
  848.  
  849.           ─────────────────────────────────────────────────────────────────
  850.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 14
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.                 156     CRITICAL:  Disk seek error
  859.                 157     CRITICAL:  Unknown media type
  860.                 158     CRITICAL:  Sector not found
  861.                 159     CRITICAL:  Printer out of paper
  862.                 160     CRITICAL:  Device write fault
  863.                 161     CRITICAL:  Device read fault
  864.                 162     CRITICAL:  Network or Hardware failure
  865.                 200     FATAL:     Division by zero
  866.                 201     FATAL:     Range check
  867.                 202     FATAL:     Stack overflow
  868.                 203     FATAL:     Heap overflow
  869.                 204     FATAL:     Bad pointer operation
  870.                 205     FATAL:     Floating point overflow
  871.                 206     FATAL:     Floating point underflow
  872.                 207     FATAL:     Bad  floating  point  operation.   Check to
  873.                                    make  sure all  the  numeric values  in the
  874.                                    PCBFRE  security  table are  of  reasonable
  875.                                    value.   Large numbers and negative numbers
  876.                                    will cause this error.
  877.                 208     FATAL:     Overlay Manager not initialized
  878.  
  879.  
  880.           ┌────────────────────────────────────────────────────────────────┐
  881.           │                         PROBLEM REPORTS                        │
  882.           └────────────────────────────────────────────────────────────────┘
  883.  
  884.  
  885.           If you need to  report a problem,  please capture the session  using
  886.           DOS environment variable "SET PRODEBUG=ON".   The ouput file  called
  887.           "DEBUG.OUT" will  be in the same  directory that  PCBFRE is executed
  888.           from.  Depending on the  node, the  file will  be named "DEBUG#.OUT"
  889.           where #  is the node number.   Please include  this file  as well as
  890.           the  USERS.SYS  file in  use  during  that  session  and a  thorough
  891.           explanation of the problem  encountered. Please ZIP  these files  up
  892.           and send it to my support BBS.
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.  
  901.  
  902.  
  903.  
  904.  
  905.  
  906.  
  907.  
  908.  
  909.  
  910.           ─────────────────────────────────────────────────────────────────
  911.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 15
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.            ┌────────────────────────────────────────────────────────────────┐
  920.            │                       SUPPORT/REGISTRATION                     │
  921.            └────────────────────────────────────────────────────────────────┘
  922.  
  923.           If  you have  any questions,  bugs, comments  or suggestions, please
  924.           contact  me. I may  be reached  on the PCBoard  conference on NANet,
  925.           City2City(tm), Intelec(tm), and other networks. I can  also be reach
  926.           on my support BBS or by snail-mail to  the above address. Registered
  927.           users may  contact me  using the  voice number  in the  registration
  928.           document. 
  929.  
  930.           Since  this  is user  supported  software,  I  don't  expect you  to
  931.           register if  you don't  like it  or if  it doesn't meet  your needs.
  932.           Just stop using it after a reasonable trial period  (2-3 weeks). The
  933.           program is  not crippled in any way,  there is only a short delay at
  934.           the start/exit of the  program to remind  the user that the copy  is
  935.           un-registered. 
  936.  
  937.           If you like the  program and use it  regularly, please register  it.
  938.           The  registration cost  is  a one-time  fee  of $20.00.    With  the
  939.           registration you'll  receive unlimited  voice support and  upgrades.
  940.           Your registration  encourages further  development, enhancement  and
  941.           my continued support of the product.   Please send your registration
  942.           in the form of a Money Order,  Personal Cheque, or Cashier's  Cheque
  943.           to the above address.
  944.  
  945.           ┌────────────────────────────────────────────────────────────────┐
  946.           │                       REGISTRATION OPTIONS                     │
  947.           └────────────────────────────────────────────────────────────────┘
  948.  
  949.  
  950.                 1 -  Your registration information will  be left  in a message
  951.                     on my support  BBS.  You'll need  to scan conference 3 for
  952.                     it.
  953.  
  954.                 2  -  I'll  upload  the  latest  copy  with  the  registration
  955.                     information to your BBS.   If you're long distance, please
  956.                     add appropriate cost to cover a long-distance call.
  957.  
  958.                 3  -  You'll  receive  the  latest   version  on  a  disk   by
  959.                     snail-mail.   Please add appropriate  costs to cover  disk
  960.                     and mailing cost.
  961.  
  962.                 4 - I'll send your registration  information in a first  class
  963.                     letter.  No additional cost is required.
  964.  
  965.                 5 -  You may  drop by  my home  to pick  up the  registration.
  966.                     Please  let  me know  in  advance.   I  live  in  a  rough
  967.                     neighborhood, so  watch yourself if  you really must  pick
  968.                     up  the registration in  person. A  few has  dropped by so
  969.                     far and have escaped safely with their registrations.
  970.  
  971.           ─────────────────────────────────────────────────────────────────
  972.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 16
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.            ┌────────────────────────────────────────────────────────────────┐
  981.            │                             CREDITS                            │
  982.            └────────────────────────────────────────────────────────────────┘
  983.  
  984.  
  985.           Thanks to Jeff Leung:
  986.  
  987.                For the great job  of providing his time  and resources on  The
  988.                GRAFIX Connection  to support PCBFRE  and my other  programming
  989.                efforts. I'd also  like to thank him waking me up at 4:00 am in
  990.                the morning everytime he thought he had found a bug in PCBFRE.
  991.  
  992.            
  993.           Thanks to Stew  Francis, Shaun Gallant, Kerry Kostner, Terry Wilson,
  994.           Dennis Kaczor, Leonard Lada:
  995.  
  996.                For all the  ideas, suggestions, bug reports, and beta  testing
  997.                during the beta cycle.  Without  the help of these individuals,
  998.                I wouldn't  have  been able  to  find  and squash  those  nasty
  999.                little bugs running loose inside PCBFRE.   Thanks guys, for the
  1000.                help, patience, and support.
  1001.  
  1002.  
  1003.           Thanks to all registered users of  PCBFRE for the continued support.
  1004.           Without such support, PCBFRE wouldn't be where it is today.
  1005.  
  1006.  
  1007.            ┌────────────────────────────────────────────────────────────────┐
  1008.            │                 STANDARD DISCLAIMERS/COPYRIGHTS                │
  1009.            └────────────────────────────────────────────────────────────────┘
  1010.  
  1011.           This program is provided  on an "AS IS" basis.   No warranty  of any
  1012.           kind is expressed  or implied.   YOU USE  THIS PROGRAM  AT YOUR  OWN
  1013.           RISK.   I take no  responsibility for any  damage caused directly or
  1014.           indirectly from the use or the inability to use this program.
  1015.  
  1016.  
  1017.           ProKit & Pro* Utilities - Copyrighted: Samuel Smith - The Tool Shop
  1018.           PCBoard                 - Copyrighted: Clarke Development Company
  1019.           Other                   - Copyrighted: Respected Owners
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025.  
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.  
  1032.           ─────────────────────────────────────────────────────────────────
  1033.           PCBoard File Ratio Enforcer v2.0 . . . . . . . . . . . . . . . 17
  1034.